home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 027a / man501.zip / MAN501.TXT
Text File  |  1990-10-12  |  8KB  |  301 lines
  1.  
  2.  BREAK()        Branch out of a BEGIN SEQUENCE...END construct
  3.  BREAK()
  4.  Branch out of a BEGIN SEQUENCE...END construct
  5.  
  6.  Syntax
  7.  
  8.      BREAK(<exp>) --> NIL
  9.  
  10.  Arguments
  11.  
  12.      <exp>is the value passed to the RECOVER clause, if any.  Note that
  13.      <exp> is not optional.  NIL may be specified if there is no break
  14.      value.
  15.  
  16.  Returns
  17.  
  18.      BREAK() always returns NIL.
  19.  
  20.  Description
  21.  
  22.      The BREAK() function is identical in functionality to the BREAK
  23.      statement.  The function must be executed during a SEQUENCE.
  24.  
  25.  Examples
  26.  
  27.      The following example illustrates how to break out of a SEQUENCE from a
  28.      code block:
  29.  
  30.      bSave := ERRORBLOCK( {|x| BREAK(x)} )
  31.  
  32.      BEGIN SEQUENCE
  33.        .
  34.        .
  35.        .
  36.      RECOVER USING objError
  37.        .
  38.        .
  39.        .
  40.      END
  41.  
  42.      ERRORBLOCK(bSave)
  43.  
  44.  Files:  Library is CLIPPER.LIB.
  45.  seealso: c5g0_003.ngo:"BEGIN SEQUENCE"
  46.  
  47.  
  48.  DEVOUT()       Write a value to the current device
  49.  DEVOUT()
  50.  Write a value to the current device
  51.  
  52.  Syntax
  53.  
  54.      DEVOUT(<exp>) --> NIL
  55.  
  56.  Arguments
  57.  
  58.      <exp>is the value to display.
  59.  
  60.  Returns
  61.  
  62.      DEVOUT() always returns NIL.
  63.  
  64.  Description
  65.  
  66.      DEVOUT() is a full-screen display function that writes the value of a
  67.      single expression to the current device at the current cursor or
  68.      printhead position.  DEVOUT() is used in combination with DEVPOS() in
  69.      STD.CH to implement the @...SAY command.
  70.  
  71.  Examples
  72.  
  73.      The following example shows the relationship between the  DEVOUT()
  74.      function and the @...SAY command:
  75.  
  76.      DEVPOS(10, 10)
  77.      DEVOUT("Hello there")
  78.      //
  79.      @ 10, 10 SAY "Hello there"
  80.  
  81.  Files:  Library is CLIPPER.LIB.
  82.  seealso: "COL()" "DEVPOS()" "OUTERR()" "OUTSTD()" "QOUT()" "ROW()" "SETPOS()"
  83.  
  84.  
  85.  GETACTIVE()    Return the currently active Get object
  86.  GETACTIVE()
  87.  Return the currently active Get object
  88.  
  89.  Syntax
  90.  
  91.      GETACTIVE() --> objGet
  92.  
  93.  Returns
  94.  
  95.      GETACTIVE() returns the current active Get object within the current
  96.      READ.  If there is no READ active when GETACTIVE() is called, it
  97.      returns NIL.
  98.  
  99.  Description
  100.  
  101.      GETACTIVE() is an environment function that provides access to the
  102.      active GET object during a READ.  The current active Get object is the
  103.      one with input focus at the time GETACTIVE() is called.
  104.  
  105.  Examples
  106.  
  107.      The code that follows uses a WHEN clause to force control to branch to
  108.      a special reader function.  Within this function, GETACTIVE() is used
  109.      to retrieve the active Get object:
  110.  
  111.      @ 10, 10 GET x
  112.      @ 11, 10 GET y WHEN MyReader()
  113.      @ 12, 10 GET z
  114.      READ
  115.  
  116.      // Called just before second get (above) becomes current
  117.      FUNCTION MyReader
  118.         LOCAL objGet               // Active Get holder
  119.         objGet := GETACTIVE()      // Retrieve current active Get
  120.         BarCodeRead( objGet )
  121.         RETURN (.F.)               // Causes Get to be skipped in regular READ
  122.  
  123.  Files:  Library is CLIPPER.LIB, source code is in Getsys.prg.
  124.  seealso: "READMODAL()" c5g0_001.ngo:"@...GET" c5g0_001.ngo:"READ"
  125.  
  126.  
  127.  OUTERR()       Write a list of values to the standard error device
  128.  OUTERR()
  129.  Write a list of values to the standard error device
  130.  
  131.  Syntax
  132.  
  133.      OUTERR(<exp list>) --> NIL
  134.  
  135.  Arguments
  136.  
  137.      <exp list>is a list of values to display and can consist of any
  138.      combination of data types including memo.
  139.  
  140.  Returns
  141.  
  142.      OUTERR() always returns NIL.
  143.  
  144.  Description
  145.  
  146.      OUTERR() is identical to OUTSTD() with the exception that it writes to
  147.      the standard error rather than the standard output device.  Output sent
  148.      to the standard error device bypasses the Clipper console and output
  149.      devices as well as any DOS redirection.  It is typically used to log
  150.      error messages in a manner that will not interfere with the standard
  151.      screen or printer output.
  152.  
  153.  Examples
  154.  
  155.      The following example displays an error message along with the date and
  156.      time of occurrence to the screen:
  157.  
  158.      OUTERR("File lock failure", DATE(), TIME())
  159.  
  160.  Files:  Library is CLIPPER.LIB.
  161.  seealso: "DISPOUT()" "OUTSTD()"
  162.  
  163.  
  164.  OUTSTD()       Write a list of values to the standard output device
  165.  OUTSTD()
  166.  Write a list of values to the standard output device
  167.  
  168.  Syntax
  169.  
  170.      OUTSTD(<exp list>) --> NIL
  171.  
  172.  Arguments
  173.  
  174.      <exp list>is a list of values to display and can consist of any
  175.      combination of data types including memo.
  176.  
  177.  Returns
  178.  
  179.      OUTSTD() always returns NIL.
  180.  
  181.  Description
  182.  
  183.      OUTSTD() is a simple output function.  The function is similar to
  184.      QOUT(), except that it writes to the STDOUT device (instead of to the
  185.      Clipper console output stream).  Programs with very simple output
  186.      requirements (e.g., that perform no full-screen input or output) can
  187.      use this function to avoid loading the terminal output subsystems.  The
  188.      header file Simplio.ch redefines the ? and ?? commands to use the
  189.      OUTSTD() function.
  190.  
  191.      Since OUTSTD() sends its output to the standard output device, the
  192.      output can be redirected using the DOS redirection symbols (>, >, |).
  193.      This allows you redirect output from a Clipper program to a file or
  194.      pipe.  Refer to your PC/MS-DOS documentation for more information on
  195.      this operating system facility.
  196.  
  197.  Examples
  198.  
  199.       The following example uses OUTSTD() to display a list of
  200.         expressions:
  201.  
  202.         OUTSTD(Name, PADR(RTRIM(City) + "," + State, 20), ZipCode)
  203.  
  204.       This example shows how redirect the output of a Clipper
  205.         program to a new file using the DOS redirection operator (>):
  206.  
  207.         C>MYPROG > FILE.TXT
  208.  
  209.  Files:  Library is CLIPPER.LIB, header file is Simplio.ch.
  210.  seealso: "DISPOUT()" "OUTERR()" "QOUT()"
  211.  
  212.  
  213.  SETBLINK()     Toggle asterisk (*) interpretation in SETCOLOR()
  214.  SETBLINK()
  215.  Toggle asterisk (*) interpretation in SETCOLOR() string between
  216.  blinking and background intensity
  217.  
  218.  Syntax
  219.  
  220.      SETBLINK([<lToggle>]) --> lCurrentSetting
  221.  
  222.  Arguments
  223.  
  224.      <lToggle>toggles the meaning of the asterisk (*) character when it is
  225.      encountered in a SETCOLOR() string.  Specifying true (.T.) causes the
  226.      asterisk to mean blinking and false (.F.) causes it to mean background
  227.      intensity.  The default is true (.T.).
  228.  
  229.  Returns
  230.  
  231.      SETBLINK() returns the current setting as a logical value.
  232.  
  233.  Description
  234.  
  235.      SETBLINK() is an environment function that toggles the
  236.      blinking/background intensity attribute and reports the current state
  237.      of SETBLINK().  When SETBLINK() is on, characters written to the screen
  238.      can be made to blink by including an asterisk (*) in a color string
  239.      passed to SETCOLOR().  When SETBLINK() is off, the asterisk (*) causes
  240.      the background color to be intensified instead.  Thus, blinking and
  241.      background intensity attributes are not available at the same time.
  242.  
  243.       Note
  244.  
  245.      This function is meaningful only on the IBM-PC or compatible computers
  246.      with CGA, EGA, or VGA display hardware.
  247.  
  248.  Examples
  249.  
  250.      This example saves the current SETBLINK() state before passing control
  251.      to a user-defined function.  Upon return, SETBLINK() is restored to its
  252.      original value:
  253.  
  254.      lOldBlink := SETBLINK()
  255.      MyFunc()
  256.      SETBLINK(lOldBlink)
  257.  
  258.  Files:  Library is CLIPPER.LIB.
  259.  seealso: "SETCOLOR()"
  260.  
  261.  
  262.  SETMODE()      Change display mode to specified number of rows, columns
  263.  SETMODE()
  264.  Change display mode to specified number of rows and columns
  265.  
  266.  Syntax
  267.  
  268.      SETMODE(<nRows>, <nCols>) --> lSuccess
  269.  
  270.  Arguments
  271.  
  272.      <nRows>is the number of rows in the desired display mode.
  273.  
  274.      <nCols>is the number of columns in the desired display mode.
  275.  
  276.  Returns
  277.  
  278.      SETMODE() returns true (.T.) if the mode change was successful;
  279.      otherwise, it returns false (.F.).
  280.  
  281.  Description
  282.  
  283.      SETMODE() is an environment function that attempts to change the mode
  284.      of the display hardware to match the number of rows and columns
  285.      specified.  The change in screen size is reflected in the values
  286.      returned by MAXROW() and MAXCOL().
  287.  
  288.  Examples
  289.  
  290.      The following example switches to a 43-line display mode:
  291.  
  292.      IF SETMODE(43, 80)
  293.        ? "43-line mode successfully set"
  294.      ELSE
  295.        ? "43-line mode not available"
  296.      ENDIF
  297.  
  298.  Files:  Library is CLIPPER.LIB.
  299.  seealso: "MAXCOL()" "MAXROW()"
  300.  
  301.